Platform Explorer / Nuxeo Platform 2023.14

Operation Context.SetWorkflowVar (Set Workflow Variable)

Description

Set a workflow variable. The workflow variable must exists on the workflow. If no workflowId is specified the variable is set on the current workflow.To compute the value at runtime from the current context you should use a MVEL expression as the value. This operation works on any input type and return back the input as the output.
Operation id Context.SetWorkflowVar
Category Workflow Context
Label Set Workflow Variable
Requires Workflow
Since

Parameters

Name Description Type Required Default value
name string yes  
value object no  
workflowInstanceId string no  

Signature

Inputs void
Outputs void

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.routing.core.api.operation.SetWorkflowVar
Contributing Component org.nuxeo.ecm.platform.routing.operations

JSON Definition

{
  "id" : "Context.SetWorkflowVar",
  "label" : "Set Workflow Variable",
  "category" : "Workflow Context",
  "requires" : "Workflow",
  "description" : "Set a workflow variable. The workflow variable must exists on the workflow. If no workflowId is specified the variable is set on the current workflow.To compute the value at runtime from the current context you should use a MVEL expression as the value. This operation works on any input type and return back the input as the output.",
  "url" : "Context.SetWorkflowVar",
  "signature" : [ "void", "void" ],
  "params" : [ {
    "name" : "name",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "value",
    "description" : null,
    "type" : "object",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "workflowInstanceId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}